Transforms forPageByBean


PageByTransform

Formal Parameter Type Default Required Description
advancedDrillingContextMenuDisplay INTEGER 1 false It is used in the transform to specify whether to show the advanced drilling options in the editor or context menu.
Allowed Values: PreferencesDrillTransform.ADVANCED_DRILLING_RMC_DISPLAY_DEFAULT = "1"
ADVANCED_DRILLING_RMC_DISPLAY_SUBMENU = "2"
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    groupContextMenuDrillPathsByType BOOLEAN false false It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
    Allowed Values: TRUE/FALSE.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    helpTopic STRING   false Indicates the help topic for the help page of the editor.
    helpType STRING user false Indicates the type of help topic this editor uses.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    isAutoSubmitEnabled BOOLEAN true false This is the flag used in the transform to specify whether to enable auto-submit functionality.
    With this functionality, the page-by element selection is automatically submitted using javascript as soon as the element is selected by the end user.
    Noticed, though, that even if this parameter is true, this functionality might be disabled if the user doesn't have enough privileges, if it's not DHTML mode, or based on the WebFeatureAutoPageBy Feature.
    Allowed Values: TRUE/FALSE.
    isContextMenuEnabled BOOLEAN true false

    Deprecated. To customize context-menus use the xml-definition specified by contextMenus


    This is the flag used in the transform to specify whether to enable context menu functionality.
    Noticed, though, that even if this parameter is true, this functionality might be disabled if the user doesn't have enough privileges or if it's not DHTML mode.
    Allowed Values: TRUE/FALSE.
    isDragAndDropEnabled BOOLEAN true false This is the flag used in the transform to specify whether to enable drag and drop functionality.
    Noticed, though, that even if this parameter is true, this functionality might be disabled if the user doesn't have enough privileges or if it's not DHTML mode.
    Allowed Values: TRUE/FALSE.
    isEditable BOOLEAN true false This flag indicates the page by attributes can be arranged or removed from the panel.
    Allowed Values: TRUE/FALSE.
    isSummaryWhenClosedEnabled BOOLEAN true false This flag indicates the Transform to render the summary section, even if the even is closed.
    When this happens, the Transform isOpen returns true even if the underlying PageByBean is closed, and invokes the renderSummary method.
    Allowed Values: TRUE/FALSE.
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    showDrillPathSetNamesSubMenuAtTopLevel BOOLEAN true false It is used in the transform to specify whether to show the set names submenu for drilling at the top level (or at a lower depth).
    Allowed Values: TRUE/FALSE.
    sortSetNamesAndDrillPaths BOOLEAN false false It is used in the transform to specify whether to show the set names and drill paths names alphabetically sorted.
    Allowed Values: TRUE/FALSE.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.